home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 7 / Night Owl Shareware (NOPV7)(Night Owl Publisher Inc.)(1992).bin / 038a / bash1_12.arj / BASH1-12.TAR / bash-1.12 / builtins / help.def < prev    next >
Text File  |  1991-11-16  |  3KB  |  135 lines
  1. This file is help.def, from which is created help.c.
  2. It implements the builtin "help" in Bash.
  3.  
  4. Copyright (C) 1987, 1989, 1991 Free Software Foundation, Inc.
  5.  
  6. This file is part of GNU Bash, the Bourne Again SHell.
  7.  
  8. Bash is free software; you can redistribute it and/or modify it under
  9. the terms of the GNU General Public License as published by the Free
  10. Software Foundation; either version 1, or (at your option) any later
  11. version.
  12.  
  13. Bash is distributed in the hope that it will be useful, but WITHOUT ANY
  14. WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15. FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16. for more details.
  17.  
  18. You should have received a copy of the GNU General Public License along
  19. with Bash; see the file COPYING.  If not, write to the Free Software
  20. Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  21.  
  22. $PRODUCES help.c
  23.  
  24. $BUILTIN help
  25. $FUNCTION help_builtin
  26. $SHORT_DOC help [pattern ...]
  27. Display helpful information about builtin commands.  If PATTERN is
  28. specified, gives detailed help on all commands matching PATTERN,
  29. otherwise a list of the builtins is printed.
  30. $END
  31.  
  32. #include <stdio.h>
  33. #include "../shell.h"
  34. #include "../builtins.h"
  35.  
  36. #if defined (USE_GLOB_LIBRARY)
  37. #  include <glob/glob.h>
  38. #else
  39. #  define FNM_NOMATCH 1
  40. #endif /* USE_GLOB_LIBRARY */
  41.  
  42. /* Print out a list of the known functions in the shell, and what they do.
  43.    If LIST is supplied, print out the list which matches for each pattern
  44.    specified. */
  45. help_builtin (list)
  46.      WORD_LIST *list;
  47. {
  48.   if (!list)
  49.     {
  50.       register int i, j;
  51.       char blurb[256];
  52.  
  53.       show_shell_version ();
  54.       printf (
  55. "Shell commands that are defined internally.  Type `help' to see this list.\n\
  56. Type `help name' to find out more about the function `name'.\n\
  57. Use `info bash' to find out more about the shell in general.\n\
  58. \n\
  59. A star (*) next to a name means that the command is disabled.\n\
  60. \n");
  61.  
  62.       for (i = 0; i < num_shell_builtins; i++)
  63.     {
  64.       QUIT;
  65.       sprintf (blurb, "%c%s", shell_builtins[i].enabled ? ' ' : '*',
  66.            shell_builtins[i].short_doc);
  67.  
  68.       blurb[35] = '\0';
  69.       printf ("%s", blurb);
  70.  
  71.       if (i % 2)
  72.         printf ("\n");
  73.       else
  74.         for (j = strlen (blurb); j < 35; j++)
  75.           putc (' ', stdout);
  76.  
  77.     }
  78.       if (i % 2)
  79.     printf ("\n");
  80.     }
  81.   else
  82.     {
  83.       int match_found = 0;
  84.       char *pattern = "";
  85.  
  86.       if (glob_pattern_p (list->word->word))
  87.     {
  88.       printf ("Shell commands matching keyword%s `",
  89.           list->next ? "s" : "");
  90.       print_word_list (list, ", ");
  91.       printf ("'\n\n");
  92.     }
  93.  
  94.       while (list)
  95.     {
  96.       register int i = 0, plen;
  97.       char *name;
  98.  
  99.       pattern = list->word->word;
  100.       plen = strlen (pattern);
  101.  
  102.       while (name = shell_builtins[i].name)
  103.         {
  104.           int doc_index;
  105.  
  106.           QUIT;
  107.           if ((strnicmp (pattern, name, plen) == 0) ||
  108.           (fnmatch (pattern, name, 0) != FNM_NOMATCH))
  109.         {
  110.           printf ("%s: %s\n", name, shell_builtins[i].short_doc);
  111.  
  112.           for (doc_index = 0;
  113.                shell_builtins[i].long_doc[doc_index]; doc_index++)
  114.             printf ("    %s\n", shell_builtins[i].long_doc[doc_index]);
  115.  
  116.           match_found++;
  117.         }
  118.           i++;
  119.         }
  120.       list = list->next;
  121.     }
  122.  
  123.       if (!match_found)
  124.     {
  125.       fprintf (stderr, "No help topics match `%s'.  Try `help help'.\n",
  126.            pattern);
  127.       fflush (stderr);
  128.       return (EXECUTION_FAILURE);
  129.     }
  130.     }
  131.   fflush (stdout);
  132.   return (EXECUTION_SUCCESS);
  133. }
  134.  
  135.